/****************************************************************************************
*            . .. .                                                                     *
*                    ...                                                                *
*                       .":                                                             *
*   .                      u                                                            *
* ..     .:uxkkOkkx=.      "k'                                                          *
*.     "k00O0ko==uk00x'     OO.                       IBE-CAE                           *
*'   .xK0O00: 'xx" x0Ku    .O0:     Copyright (C) by Internet Based Engineering         *
*   .O0OO00= oKOk:"O0O'    :00=                 All rights reserved.                    *
*.  =0OOO00" =OOO0Oo'     =0OO:                      www.ibe.cn                         *
*.  u0OOOO0O'          .o00OOO.                                                         *
* . :KOOOOO00xu=:::=uok00OOOO"                                                          *
*   .x00OOOOOO0000000OOOOOOx.                                                           *
*    .u00OOOOOOOOOOOOOOOOO=                                                             *
*      .ukOOOOOOOOOOOOku'                                                               *
*          .'::==::'.                                                                   *
****************************************************************************************/

#ifndef IBE_CASE_H_
#define IBE_CASE_H_

#include <string>
#include <vector>

#include "IBE_Object.h"

namespace ibe_common
{
    class IBE_CaseStep;

    /**
    * @class IBE_Case
    * @brief 分析步数据信息
    * @author liupeng
    */
    class IBE_COMMON_EXPORT IBE_Case : public IBE_Object
    {
    public:
        explicit IBE_Case();
        ~IBE_Case();

        IBE_TypeMacro( ibe_common, IBE_Case, ibe_common, IBE_Object );

        virtual void Initialize() override;
        /**
        * @brief 移除所有时间步内容（不delete内容）
        */
        virtual void ClearAllSteps();
        /**
        * @brief 移除所有时间步内容（会delete内容）
        */
        virtual void DeleteAllSteps();

        //@{
        /**
         * @brief 设置/获取分析步标签
         *
         * @param label 分析步标签
         * @return 分析步标签
         */
        virtual void SetCaseLabel( const char* label );
        virtual const char* GetCaseLabel()
        {
            return this->caseLabel_.c_str();
        }
        //@}

        //@{
        /**
         * @brief 设置/获取分析步名称
         *
         * @param name 分析步名称
         * @return 分析步名称
         */
        virtual void SetCaseName( const char* name );
        virtual const char* GetCaseName()
        {
            return this->caseName_.c_str();
        }
        //@}

        //@{
        /**
        * @brief 添加时间步信息
        *
        * @param stepInfo 单个时间步
        */
        virtual void AddStep( IBE_CaseStep* stepInfo );
        /**
        * @brief 移除时间步信息（没有delete内容）
        *
        * @param stepInfo 单个时间步
        * @param index 单个时间步索引
        */
        virtual void RemoveStep( IBE_CaseStep* stepInfo );
        virtual void RemoveStep( const int index );
        /**
        * @brief 移除时间步信息（会delete内容）
        *
        * @param stepInfo 单个时间步
        */
        virtual void DeleteStep( IBE_CaseStep* stepInfo );
        virtual void DeleteStep( const int index );
        /**
        * @brief 获取时间步索引
        *
        * @param stepInfo 单个时间步
        * @return 时间步索引
        */
        virtual int GetStepIndex( IBE_CaseStep* stepInfo );
        /**
        * @brief 通过时间步索引，获取对应的时间步信息
        *
        * @param index 时间步索引
        * @return 时间步信息
        */
        virtual IBE_CaseStep* GetStep( const int index );
        /**
        * @brief 获取时间步个数
        *
        * @return 时间步个数
        */
        virtual int GetNumberOfSteps();
        //@}

        virtual void Copy( ibe_common::IBE_Object* obj ) override;
        /**
         * @brief 复制基础信息，不复制IBE_CaseStep信息
         *
         * @param obj 被复制的对象
         */
        virtual void CopyBase( ibe_common::IBE_Object* obj );
        /**
        * @brief 只复制时间步/增量步信息
        *
        * @param obj 被复制的对象
        */
        virtual void CopyStepInfos( ibe_common::IBE_Object* obj );

    protected:
        std::string caseLabel_; //!< 分析步标签
        std::string caseName_; //!< 分析步名称
        //! 存储所有的时间步/增量步信息
        std::vector<IBE_CaseStep*> stepInfos_;

    private:
        IBE_Case( const IBE_Case& ) = delete;
        IBE_Case& operator=( const IBE_Case& ) = delete;
    };
} // namespace ibe_common

#endif // IBE_CASE_H_